docs: add initial_path configuration for preview environment ports#519
docs: add initial_path configuration for preview environment ports#519roomote[bot] wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Review complete. Found 1 documentation inconsistency that should be clarified.
Mention @roomote in a comment to request specific changes to this pull request or fix all unresolved issues. |
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
| | `name: WEB, port: 3000` | `ROO_WEB_HOST` | `https://abc123.vercel.run` | | ||
| | `name: API, port: 3001` | `ROO_API_HOST` | `https://def456.vercel.run` | | ||
| | `name: ADMIN, port: 3002` | `ROO_ADMIN_HOST` | `https://ghi789.vercel.run` | | ||
| | `name: ADMIN, port: 3002, initial_path: /dashboard` | `ROO_ADMIN_HOST` | `https://ghi789.vercel.run/dashboard` | |
There was a problem hiding this comment.
This table row shows ROO_ADMIN_HOST including the path (/dashboard), but the text description below (lines 118 and 129) states that initial_path only affects the "preview link" and "preview URL provided in the UI and task" - not the environment variable. If the env var actually includes the path, the CORS code examples elsewhere in this doc (lines 385-393) would break since CORS origins don't include paths. If initial_path only affects the UI preview URL, this row should show https://ghi789.vercel.run without the path.
Fix it with Roo Code or mention @roomote and request a fix.
1 participant
This PR adds documentation for the new
initial_pathproperty in preview environment port configurations.Changes
initial_pathto the port configuration fields table/, valid URI path characters)initial_pathvaluesinitial_pathaffects the resulting URLUse Case
Preview environments currently load a blank page at the root path, which does not work for applications where the entry point is at a different path (e.g.,
/login). Theinitial_pathproperty allows users to specify the default path that will be appended to the preview URL when the service starts.View task on Roo Code Cloud
Important
Add documentation for
initial_pathconfiguration in preview environment ports, detailing its purpose, usage, and validation rules.initial_pathto port configuration fields inenvironments.mdx.initial_path(must start with/, valid URI path characters).initial_patheffect on URLs.initial_pathvalues.This description was created by
for 83c7d30. You can customize this summary. It will automatically update as commits are pushed.